/****************************************************************************
 * Copyright 2009 Huascar A. Sanchez                                        *
 *                                                                          *
 * Licensed under the Apache License, Version 2.0 (the "License");          *
 * you may not use this file except in compliance with the License.         *
 * You may obtain a copy of the License at                                  *
 *                                                                          *
 *     http://www.apache.org/licenses/LICENSE-2.0                           *
 *                                                                          *
 * Unless required by applicable law or agreed to in writing, software      *
 * distributed under the License is distributed on an "AS IS" BASIS,        *
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
 * See the License for the specific language governing permissions and      *
 * limitations under the License.                                           *
 ****************************************************************************/
package com.gotobject.greatq.circuitbreaker;

/**
 * @author huascar.sanchez@gmail.com (Huascar A. Sanchez)
 */
public interface CircuitBreaker <T extends Exception> {
    /**
     * cb acknowledges the intended call.
     * @throws T
     *      the exception thrown by the faulty method.
     */
    void callStarted() throws T;

    /**
     * cb changes its state to {@link Status#CLOSED}
     */
    void callSucceeded();

    /**
     * cb remains or changes its state to {@link Status#OPENED}
     * @param error
     *      error that opened circuit breaker.
     *
     */
    void callFailed(T error);

    /**
     * @return
     *      the status of the breaker.
     */
    Status status();
}
